home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.1 / eid.1 < prev    next >
Encoding:
Text File  |  1995-07-26  |  6.6 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      LLLLIIIIDDDD((((1111))))                    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                    LLLLIIIIDDDD((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           lid, gid, eid - query id database
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           lllliiiidddd [----fffffile] [----uuuun] [----eeeeddddooooxxxxaaaammmmssssvvvveeee]]]] patterns...
  13.  
  14.           ggggiiiidddd [----fffffile] [----eeeeddddooooxxxxaaaammmmsssseeee]]]] patterns...
  15.  
  16.           eeeeiiiidddd [----fffffile] [----ddddooooxxxxaaaammmmsssseeee]]]] patterns...
  17.  
  18.           aaaaiiiidddd [----fffffile] [----ddddooooxxxxaaaammmmssssvvvv]]]] patterns...
  19.  
  20.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.           These commands provide a flexible query interface to the _i_d
  22.           database.  _L_i_d does a lookup on _p_a_t_t_e_r_s and prints out lines
  23.           in this way:
  24.  
  25.           idname        ../hdir/hfile.h ../cdir/{cfile1,cfile2}.c
  26.  
  27.           Notice that multiple files with the same directory prefix
  28.           and suffix are concatenated in the globbing-set-notation of
  29.           _c_s_h(1) (see the ----vvvv flag to alter this behaviour).  Also
  30.           notice that all of the _i_d database query commands adjust the
  31.           list of pathnames to be relative to your current working
  32.           directory, provided that _m_k_i_d(1) was used to build the
  33.           database, and your working directory is located within the
  34.           sub-tree covered by the _i_d database.
  35.  
  36.           If multiple names match on pattern, then there will be one
  37.           line of output per name.  The mnemonic significance of the
  38.           name is _l(_o_o_k_u_p) _i_d.
  39.  
  40.           _G_i_d does a lookup and then searches for the names it matches
  41.           in the files where they occur.  The mnemonic for this name
  42.           is _g(_r_e_p)_i_d.
  43.  
  44.           _E_i_d does a lookup, and then invokes an editor on all files
  45.           with the matched name as an initial search string.  Of
  46.           course, this name stands for _e(_d_i_t) _i_d.
  47.  
  48.           _E_i_d uses four environment variables to control its
  49.           invocation of the editor.  Naturally, EEEEDDDDIIIITTTTOOOORRRR is used to
  50.           locate the editing program.  EEEEIIIIDDDDAAAARRRRGGGG is a _p_r_i_n_t_f(3S) string
  51.           used to specify the form of the initial-search-string
  52.           argument.  If the editor does not support such an argument,
  53.           this variable may be left unset.  EEEEIIIIDDDDLLLLDDDDEEEELLLL and EEEEIIIIDDDDRRRRDDDDEEEELLLL
  54.           specify the form of the left and right word-delimiters
  55.           respectively.  The best way to explain the use of these last
  56.           three variables is with an example.  Here are the proper
  57.           settings for vi(1):
  58.           EIDARG='+/%s/' # initial search argument template
  59.           EIDLDEL='\<'   # left word-delimiter
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 3/9/94)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      LLLLIIIIDDDD((((1111))))                    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                    LLLLIIIIDDDD((((1111))))
  71.  
  72.  
  73.  
  74.           EIDRDEL='\>'   # right word-delimiter
  75.  
  76.           _P_a_t_t_e_r_n_s may be simple alpha-numeric strings, or regular
  77.           expressions in the style of _r_e_g_c_m_p(3).  If the string
  78.           contains no regular-expression meta-characters, it is
  79.           searched for as a _w_o_r_d.  If the string contains meta-
  80.           characters, or if the -e argument is supplied, it is
  81.           searched for as regular-expression.
  82.  
  83.           _A_i_d produces output in the style of _l_i_d but its pattern
  84.           arguments are searched for as substrings within the
  85.           identifiers in the database.  No regular-expression search
  86.           is performed, even if the pattern contains meta-characters.
  87.           The search is conducted in an alphabetic case insensitive
  88.           manner.  The mnemonic for this name is _a(_p_r_o_p_o_s) _i_d.
  89.  
  90.           The following options are recognized:
  91.  
  92.           ----fffffile    Use _f_i_l_e as the database instead of the default
  93.                     IIIIDDDD.
  94.  
  95.           ----uuuun       Lists all identifiers in the database that are
  96.                     non-unique within the first _n characters.  This
  97.                     facility is particularly helpful when porting a
  98.                     program to a system whose compiler or linker has
  99.                     fewer significant characters for identifiers.
  100.  
  101.           The remaining options are for use in conjunction with
  102.           numeric patterns:
  103.  
  104.           ----ddddooooxxxxaaaa     These options may be specified in any combination.
  105.                     They limit numeric matches to specific radixes.
  106.                     The ----dddd, ----oooo, and ----xxxx options limit matches to
  107.                     decimal, octal, and hexadecimal respectively.  The
  108.                     ----aaaa option is a shorthand for specifying all three
  109.                     radixes.
  110.  
  111.           Searches for numbers are conducted numerically rather than
  112.           lexically, so that all representations for a given number
  113.           are potentially available from a single search.
  114.  
  115.           ----mmmm        Merge multiple lines of output into a single line.
  116.  
  117.           ----ssss        Limit the results of the search to identifiers
  118.                     that occur only once in the entire set of sources
  119.                     covered by the database.  This option is useful
  120.                     for finding identifiers that are defined but never
  121.                     used.
  122.  
  123.           ----vvvv        Be verbose for _a_i_d and _l_i_d output, that is, do not
  124.                     compact the list with _c_s_h(1) globbing.
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 3/9/94)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      LLLLIIIIDDDD((((1111))))                    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                    LLLLIIIIDDDD((((1111))))
  137.  
  138.  
  139.  
  140.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  141.           mkid(1), fid(1).
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                           (printed 3/9/94)
  196.  
  197.  
  198.  
  199.